home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dbase / dscar1.zip / DSCAR.DOC < prev    next >
Text File  |  1986-07-02  |  37KB  |  1,201 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                    d S C A R
  20.  
  21.                      dBASE Source Code Analyzer & Reporter
  22.  
  23.                                        by
  24.  
  25.                                    Ryan Katri
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                                   Version 1.0
  32.                                   July 1, 1986
  33.  
  34.  
  35.  
  36.  
  37.  
  38.                                    Ryan Katri
  39.                               2575 Drake Hill Road
  40.                                Fortuna, CA  95540
  41.  
  42.                              Voice:  (707) 725-5559
  43.                              Modem:  (707) 725-9612   (7pm-3pm)
  44.  
  45.  
  46.  
  47.  
  48.  
  49.                         Copyright (c) 1986 by Ryan Katri
  50.                               All Right Reserved.
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.                               dSCAR User's Guide
  73.                               Table of Contents
  74.  
  75.                Purpose . . . . . . . . . . . . . . . . . . . .3
  76.                System Requirements . . . . . . . . . . . . . .3
  77.                Read This!  . . . . . . . . . . . . . . . . . .3
  78.                Installation  . . . . . . . . . . . . . . . . .5
  79.                Invoking dSCAR  . . . . . . . . . . . . . . . .6
  80.                The Menu  . . . . . . . . . . . . . . . . . . .7
  81.                Quitting dSCAR. . . . . . . . . . . . . . . . .8
  82.                Diagram Program Flow  . . . . . . . . . . . . .8
  83.                Control Only  . . . . . . . . . . . . . . . . .9
  84.                Errors Only . . . . . . . . . . . . . . . . . .9
  85.                Line Numbering  . . . . . . . . . . . . . . . .9
  86.                Modules . . . . . . . . . . . . . . . . . . . .10
  87.                Variables Cross-Reference . . . . . . . . . . .10
  88.                Output  . . . . . . . . . . . . . . . . . . . .11
  89.                GO! . . . . . . . . . . . . . . . . . . . . . .12
  90.                Additional Modules  . . . . . . . . . . . . . .12
  91.                Batch Mode  . . . . . . . . . . . . . . . . . .13
  92.                Limitations . . . . . . . . . . . . . . . . . .14
  93.                Appendix A: Reporting Problems  . . . . . . . .15
  94.                Appendix B: Error Messages  . . . . . . . . . .16
  95.                Appendix C: Future Enhancements . . . . . . . .17
  96.                Appendix D: About Me & My Program & My Help . .18
  97.                Appendix E: Disclaimer. . . . . . . . . . . . .19
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                     Page 3   
  126.  
  127.           
  128.  
  129.           -Purpose-
  130.           ---------
  131.  
  132.           To put it bluntly,  dSCAR is a tool for dBASE III and  dBASE  III
  133.           Plus that performs the following functions:
  134.  
  135.                -- Structured formatting of dBASE code (indentation).
  136.  
  137.                -- Flow diagrams to highlight control statements.
  138.  
  139.                -- Cross-referencing of variables and field names.
  140.  
  141.                -- Display structural errors in code.
  142.  
  143.                -- Line numbering of source code.
  144.  
  145.                -- Selectable options to get the report you want.
  146.  
  147.                -- Ability to send any reports to screen, printer or disk.
  148.  
  149.                -- Menu-driven or command-driven.
  150.  
  151.           -System Requirements-
  152.           ---------------------
  153.  
  154.           dSCAR  should  work  on  any IBM PC/XT or compatible machine that
  155.           meets the requirements of running dBASE III or dBASE III Plus.
  156.  
  157.           It was developed under PC-Dos 3.1,  but should work on most lower
  158.           versions of Dos.
  159.  
  160.           dSCAR  can  also process dBASE II source code.  The only drawback
  161.           is if you use a dBASE III reserved word for a variable  or  field
  162.           name.  If  this  is  done,  the  variable  or  field  name is NOT
  163.           included  in  the  variables  cross-reference.   You   may   also
  164.           experience  this  problem  using  dBASE  III if you have used any
  165.           dBASE III Plus reserved words as variables.
  166.  
  167.           -READ THIS!-
  168.           ------------
  169.  
  170.           This is a full-fledged version of dSCAR.  The only drawback to it
  171.           is that it displays a title page every time  it  is  brought  up.
  172.           This screen can by by-passed by pressing <return>.
  173.  
  174.           If <return> is not pressed, dSCAR will continue execution after a
  175.           30-second wait, thus allowing dSCAR to be run in batch files with
  176.           un-attended operation.
  177.  
  178.           Optionally,  you  can  press  the  letter  key 'I' to bring up an
  179.           invoice for dSCAR that can be printed by hitting Shift+PrtScr.
  180.  
  181.  
  182.  
  183.  
  184.  
  185.                                     Page 4   
  186.  
  187.           You can register your copy of dSCAR by sending $20 - $100,000 (or
  188.           more if you have it!) to this name and address:
  189.  
  190.                            Ryan Katri
  191.                            2575 Drake Hill Road
  192.                            Fortuna, CA  95540
  193.  
  194.           If  you  do register you will receive the latest version of dSCAR
  195.           (are there going to be any more versions?) without the title page
  196.           garbage.  In this form, dSCAR can be instantly fired up and ready
  197.           to go to work on your dBASE code!
  198.  
  199.           When you register,  be sure to include your mailing  address  and
  200.           phone  number.  I would also appreciate any comments about dSCAR:
  201.           suggestions for improvements, how you are using it, where you got
  202.           it, etc.
  203.  
  204.           The registered version will be sent to you through  the  mail  or
  205.           you can elect to download it from my Bulletin Board System:
  206.  
  207.                              M.I.T. Colossus
  208.                              (707) 725-9612
  209.                              7pm-3pm, 7 days a week.
  210.                              300/1200/2400 Baud
  211.  
  212.           The latest demo version can also be found on my BBS.
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.                                     Page 5   
  246.  
  247.           
  248.  
  249.           -Installation-
  250.           --------------
  251.  
  252.           To  configure  dSCAR for your particular system setup,  run dSCAR
  253.           using 'C' as an argument on the command line, like this:
  254.  
  255.                            DSCAR C
  256.  
  257.           dSCAR immediately comes up with  the  installation  questions  to
  258.           customize  it  for  both your needs and your hardware (especially
  259.           your  printer).   Each  question  is  detailed  below  under  its
  260.           appropriate heading.  Note that defaults are displayed except for
  261.           certain questions.  All yes/no questions default to 'no'.
  262.  
  263.           Your basic cursor editing keys are in effect. <Insert>, <Delete>,
  264.           and arrow keys all work like you would expect.
  265.  
  266.           NUMBER  OF  SPACES  FOR  INDENTATION:  This  is  the  indentation
  267.              increment you want to use below control  statements,  such  as
  268.              IF, DO WHILE, DO CASE, etc.  Shown below are two pieces of the
  269.              same  code,  the first with an indentation of 3 and the second
  270.              with an indentation of 5.
  271.  
  272.                  store 1 to count                 This is code produced
  273.                  do while count < 100             with an indentation
  274.                      if count = 50 then           of three (3).
  275.                         ? 'Halfway there!'
  276.                      endif
  277.                      x = x + 1
  278.                  enddo
  279.  
  280.                  store 1 to count                 This is with indentation
  281.                  do while count < 100             five (5).
  282.                        if count = 50 then
  283.                             ? 'Halfway there!'
  284.                        endif
  285.                        x = x + 1
  286.                  enddo
  287.  
  288.  
  289.           STRIP DRIVE/PATH FROM FILENAMES:  This options defaults to  'no',
  290.              use  the  drive  and  path specified.  Regardless of what this
  291.              option is set to,  dSCAR always recognizes and uses  any  path
  292.              appended to the main file you enter at start-up.
  293.  
  294.              This  option  is  especially important when the option Modules
  295.              (detailed later) is turned on.  See the  Modules  sectio